Package pl.wendigo.chrome.api.dom

Contains DevTools Protocol DOM domain implementation accessible via DOMDomain class.

Types

AttributeModifiedEvent

data class AttributeModifiedEvent(nodeId: NodeId, name: String, value: String) : Event

Fired when Element's attribute is modified.

AttributeRemovedEvent

data class AttributeRemovedEvent(nodeId: NodeId, name: String) : Event

Fired when Element's attribute is removed.

BackendNode

data class BackendNode(nodeType: Int, nodeName: String, backendNodeId: BackendNodeId)

Backend node with a friendly name.

BackendNodeId

typealias BackendNodeId = Int

Unique DOM node identifier used to reference a node that may not have been pushed to the front-end.

BoxModel

data class BoxModel(content: Quad, padding: Quad, border: Quad, margin: Quad, width: Int, height: Int, shapeOutside: ShapeOutsideInfo?)

Box model.

CharacterDataModifiedEvent

data class CharacterDataModifiedEvent(nodeId: NodeId, characterData: String) : Event

Mirrors DOMCharacterDataModified event.

ChildNodeCountUpdatedEvent

data class ChildNodeCountUpdatedEvent(nodeId: NodeId, childNodeCount: Int) : Event

Fired when Container's child node count has changed.

ChildNodeInsertedEvent

data class ChildNodeInsertedEvent(parentNodeId: NodeId, previousNodeId: NodeId, node: Node) : Event

Mirrors DOMNodeInserted event.

ChildNodeRemovedEvent

data class ChildNodeRemovedEvent(parentNodeId: NodeId, nodeId: NodeId) : Event

Mirrors DOMNodeRemoved event.

CollectClassNamesFromSubtreeRequest

data class CollectClassNamesFromSubtreeRequest(nodeId: NodeId)

Represents request frame that can be used with DOM#collectClassNamesFromSubtree operation call.

CollectClassNamesFromSubtreeResponse

data class CollectClassNamesFromSubtreeResponse(classNames: List<String>)

Represents response frame that is returned from DOM#collectClassNamesFromSubtree operation call.

CopyToRequest

data class CopyToRequest(nodeId: NodeId, targetNodeId: NodeId, insertBeforeNodeId: NodeId?)

Represents request frame that can be used with DOM#copyTo operation call.

CopyToResponse

data class CopyToResponse(nodeId: NodeId)

Represents response frame that is returned from DOM#copyTo operation call.

CSSComputedStyleProperty

data class CSSComputedStyleProperty(name: String, value: String)

DescribeNodeRequest

data class DescribeNodeRequest(nodeId: NodeId?, backendNodeId: BackendNodeId?, objectId: RemoteObjectId?, depth: Int?, pierce: Boolean?)

Represents request frame that can be used with DOM#describeNode operation call.

DescribeNodeResponse

data class DescribeNodeResponse(node: Node)

Represents response frame that is returned from DOM#describeNode operation call.

DiscardSearchResultsRequest

data class DiscardSearchResultsRequest(searchId: String)

Represents request frame that can be used with DOM#discardSearchResults operation call.

DistributedNodesUpdatedEvent

data class DistributedNodesUpdatedEvent(insertionPointId: NodeId, distributedNodes: List<BackendNode>) : Event

Called when distrubution is changed.

DOMDomain

class DOMDomain : Domain

This domain exposes DOM read/write operations.

FocusRequest

data class FocusRequest(nodeId: NodeId?, backendNodeId: BackendNodeId?, objectId: RemoteObjectId?)

Represents request frame that can be used with DOM#focus operation call.

GetAttributesRequest

data class GetAttributesRequest(nodeId: NodeId)

Represents request frame that can be used with DOM#getAttributes operation call.

GetAttributesResponse

data class GetAttributesResponse(attributes: List<String>)

Represents response frame that is returned from DOM#getAttributes operation call.

GetBoxModelRequest

data class GetBoxModelRequest(nodeId: NodeId?, backendNodeId: BackendNodeId?, objectId: RemoteObjectId?)

Represents request frame that can be used with DOM#getBoxModel operation call.

GetBoxModelResponse

data class GetBoxModelResponse(model: BoxModel)

Represents response frame that is returned from DOM#getBoxModel operation call.

GetContentQuadsRequest

data class GetContentQuadsRequest(nodeId: NodeId?, backendNodeId: BackendNodeId?, objectId: RemoteObjectId?)

Represents request frame that can be used with DOM#getContentQuads operation call.

GetContentQuadsResponse

data class GetContentQuadsResponse(quads: List<Quad>)

Represents response frame that is returned from DOM#getContentQuads operation call.

GetDocumentRequest

data class GetDocumentRequest(depth: Int?, pierce: Boolean?)

Represents request frame that can be used with DOM#getDocument operation call.

GetDocumentResponse

data class GetDocumentResponse(root: Node)

Represents response frame that is returned from DOM#getDocument operation call.

GetFileInfoRequest

data class GetFileInfoRequest(objectId: RemoteObjectId)

Represents request frame that can be used with DOM#getFileInfo operation call.

GetFileInfoResponse

data class GetFileInfoResponse(path: String)

Represents response frame that is returned from DOM#getFileInfo operation call.

GetFlattenedDocumentRequest

data class GetFlattenedDocumentRequest(depth: Int?, pierce: Boolean?)

Represents request frame that can be used with DOM#getFlattenedDocument operation call.

GetFlattenedDocumentResponse

data class GetFlattenedDocumentResponse(nodes: List<Node>)

Represents response frame that is returned from DOM#getFlattenedDocument operation call.

GetFrameOwnerRequest

data class GetFrameOwnerRequest(frameId: FrameId)

Represents request frame that can be used with DOM#getFrameOwner operation call.

GetFrameOwnerResponse

data class GetFrameOwnerResponse(backendNodeId: BackendNodeId, nodeId: NodeId?)

Represents response frame that is returned from DOM#getFrameOwner operation call.

GetNodeForLocationRequest

data class GetNodeForLocationRequest(x: Int, y: Int, includeUserAgentShadowDOM: Boolean?, ignorePointerEventsNone: Boolean?)

Represents request frame that can be used with DOM#getNodeForLocation operation call.

GetNodeForLocationResponse

data class GetNodeForLocationResponse(backendNodeId: BackendNodeId, frameId: FrameId, nodeId: NodeId?)

Represents response frame that is returned from DOM#getNodeForLocation operation call.

GetNodesForSubtreeByStyleRequest

data class GetNodesForSubtreeByStyleRequest(nodeId: NodeId, computedStyles: List<CSSComputedStyleProperty>, pierce: Boolean?)

Represents request frame that can be used with DOM#getNodesForSubtreeByStyle operation call.

GetNodesForSubtreeByStyleResponse

data class GetNodesForSubtreeByStyleResponse(nodeIds: List<NodeId>)

Represents response frame that is returned from DOM#getNodesForSubtreeByStyle operation call.

GetNodeStackTracesRequest

data class GetNodeStackTracesRequest(nodeId: NodeId)

Represents request frame that can be used with DOM#getNodeStackTraces operation call.

GetNodeStackTracesResponse

data class GetNodeStackTracesResponse(creation: StackTrace?)

Represents response frame that is returned from DOM#getNodeStackTraces operation call.

GetOuterHTMLRequest

data class GetOuterHTMLRequest(nodeId: NodeId?, backendNodeId: BackendNodeId?, objectId: RemoteObjectId?)

Represents request frame that can be used with DOM#getOuterHTML operation call.

GetOuterHTMLResponse

data class GetOuterHTMLResponse(outerHTML: String)

Represents response frame that is returned from DOM#getOuterHTML operation call.

GetRelayoutBoundaryRequest

data class GetRelayoutBoundaryRequest(nodeId: NodeId)

Represents request frame that can be used with DOM#getRelayoutBoundary operation call.

GetRelayoutBoundaryResponse

data class GetRelayoutBoundaryResponse(nodeId: NodeId)

Represents response frame that is returned from DOM#getRelayoutBoundary operation call.

GetSearchResultsRequest

data class GetSearchResultsRequest(searchId: String, fromIndex: Int, toIndex: Int)

Represents request frame that can be used with DOM#getSearchResults operation call.

GetSearchResultsResponse

data class GetSearchResultsResponse(nodeIds: List<NodeId>)

Represents response frame that is returned from DOM#getSearchResults operation call.

InlineStyleInvalidatedEvent

data class InlineStyleInvalidatedEvent(nodeIds: List<NodeId>) : Event

Fired when Element's inline style is modified via a CSS property modification.

MoveToRequest

data class MoveToRequest(nodeId: NodeId, targetNodeId: NodeId, insertBeforeNodeId: NodeId?)

Represents request frame that can be used with DOM#moveTo operation call.

MoveToResponse

data class MoveToResponse(nodeId: NodeId)

Represents response frame that is returned from DOM#moveTo operation call.

Node

data class Node(nodeId: NodeId, parentId: NodeId?, backendNodeId: BackendNodeId, nodeType: Int, nodeName: String, localName: String, nodeValue: String, childNodeCount: Int?, children: List<Node>?, attributes: List<String>?, documentURL: String?, baseURL: String?, publicId: String?, systemId: String?, internalSubset: String?, xmlVersion: String?, name: String?, value: String?, pseudoType: PseudoType?, shadowRootType: ShadowRootType?, frameId: FrameId?, contentDocument: Node?, shadowRoots: List<Node>?, templateContent: Node?, pseudoElements: List<Node>?, importedDocument: Node?, distributedNodes: List<BackendNode>?, isSVG: Boolean?)

DOM interaction is implemented in terms of mirror objects that represent the actual DOM nodes.

NodeId

typealias NodeId = Int

Unique DOM node identifier.

PerformSearchRequest

data class PerformSearchRequest(query: String, includeUserAgentShadowDOM: Boolean?)

Represents request frame that can be used with DOM#performSearch operation call.

PerformSearchResponse

data class PerformSearchResponse(searchId: String, resultCount: Int)

Represents response frame that is returned from DOM#performSearch operation call.

PseudoElementAddedEvent

data class PseudoElementAddedEvent(parentId: NodeId, pseudoElement: Node) : Event

Called when a pseudo element is added to an element.

PseudoElementRemovedEvent

data class PseudoElementRemovedEvent(parentId: NodeId, pseudoElementId: NodeId) : Event

Called when a pseudo element is removed from an element.

PseudoType

enum PseudoType : Enum<PseudoType>

Pseudo element type.

PushNodeByPathToFrontendRequest

data class PushNodeByPathToFrontendRequest(path: String)

Represents request frame that can be used with DOM#pushNodeByPathToFrontend operation call.

PushNodeByPathToFrontendResponse

data class PushNodeByPathToFrontendResponse(nodeId: NodeId)

Represents response frame that is returned from DOM#pushNodeByPathToFrontend operation call.

PushNodesByBackendIdsToFrontendRequest

data class PushNodesByBackendIdsToFrontendRequest(backendNodeIds: List<BackendNodeId>)

Represents request frame that can be used with DOM#pushNodesByBackendIdsToFrontend operation call.

PushNodesByBackendIdsToFrontendResponse

data class PushNodesByBackendIdsToFrontendResponse(nodeIds: List<NodeId>)

Represents response frame that is returned from DOM#pushNodesByBackendIdsToFrontend operation call.

Quad

typealias Quad = List<Double>

An array of quad vertices, x immediately followed by y for each point, points clock-wise.

QuerySelectorAllRequest

data class QuerySelectorAllRequest(nodeId: NodeId, selector: String)

Represents request frame that can be used with DOM#querySelectorAll operation call.

QuerySelectorAllResponse

data class QuerySelectorAllResponse(nodeIds: List<NodeId>)

Represents response frame that is returned from DOM#querySelectorAll operation call.

QuerySelectorRequest

data class QuerySelectorRequest(nodeId: NodeId, selector: String)

Represents request frame that can be used with DOM#querySelector operation call.

QuerySelectorResponse

data class QuerySelectorResponse(nodeId: NodeId)

Represents response frame that is returned from DOM#querySelector operation call.

Rect

data class Rect(x: Double, y: Double, width: Double, height: Double)

Rectangle.

RemoveAttributeRequest

data class RemoveAttributeRequest(nodeId: NodeId, name: String)

Represents request frame that can be used with DOM#removeAttribute operation call.

RemoveNodeRequest

data class RemoveNodeRequest(nodeId: NodeId)

Represents request frame that can be used with DOM#removeNode operation call.

RequestChildNodesRequest

data class RequestChildNodesRequest(nodeId: NodeId, depth: Int?, pierce: Boolean?)

Represents request frame that can be used with DOM#requestChildNodes operation call.

RequestNodeRequest

data class RequestNodeRequest(objectId: RemoteObjectId)

Represents request frame that can be used with DOM#requestNode operation call.

RequestNodeResponse

data class RequestNodeResponse(nodeId: NodeId)

Represents response frame that is returned from DOM#requestNode operation call.

ResolveNodeRequest

data class ResolveNodeRequest(nodeId: NodeId?, backendNodeId: BackendNodeId?, objectGroup: String?, executionContextId: ExecutionContextId?)

Represents request frame that can be used with DOM#resolveNode operation call.

ResolveNodeResponse

data class ResolveNodeResponse(_object: RemoteObject)

Represents response frame that is returned from DOM#resolveNode operation call.

RGBA

data class RGBA(r: Int, g: Int, b: Int, a: Double?)

A structure holding an RGBA color.

ScrollIntoViewIfNeededRequest

data class ScrollIntoViewIfNeededRequest(nodeId: NodeId?, backendNodeId: BackendNodeId?, objectId: RemoteObjectId?, rect: Rect?)

Represents request frame that can be used with DOM#scrollIntoViewIfNeeded operation call.

SetAttributesAsTextRequest

data class SetAttributesAsTextRequest(nodeId: NodeId, text: String, name: String?)

Represents request frame that can be used with DOM#setAttributesAsText operation call.

SetAttributeValueRequest

data class SetAttributeValueRequest(nodeId: NodeId, name: String, value: String)

Represents request frame that can be used with DOM#setAttributeValue operation call.

SetChildNodesEvent

data class SetChildNodesEvent(parentId: NodeId, nodes: List<Node>) : Event

Fired when backend wants to provide client with the missing DOM structure.

SetFileInputFilesRequest

data class SetFileInputFilesRequest(files: List<String>, nodeId: NodeId?, backendNodeId: BackendNodeId?, objectId: RemoteObjectId?)

Represents request frame that can be used with DOM#setFileInputFiles operation call.

SetInspectedNodeRequest

data class SetInspectedNodeRequest(nodeId: NodeId)

Represents request frame that can be used with DOM#setInspectedNode operation call.

SetNodeNameRequest

data class SetNodeNameRequest(nodeId: NodeId, name: String)

Represents request frame that can be used with DOM#setNodeName operation call.

SetNodeNameResponse

data class SetNodeNameResponse(nodeId: NodeId)

Represents response frame that is returned from DOM#setNodeName operation call.

SetNodeStackTracesEnabledRequest

data class SetNodeStackTracesEnabledRequest(enable: Boolean)

Represents request frame that can be used with DOM#setNodeStackTracesEnabled operation call.

SetNodeValueRequest

data class SetNodeValueRequest(nodeId: NodeId, value: String)

Represents request frame that can be used with DOM#setNodeValue operation call.

SetOuterHTMLRequest

data class SetOuterHTMLRequest(nodeId: NodeId, outerHTML: String)

Represents request frame that can be used with DOM#setOuterHTML operation call.

ShadowRootPoppedEvent

data class ShadowRootPoppedEvent(hostId: NodeId, rootId: NodeId) : Event

Called when shadow root is popped from the element.

ShadowRootPushedEvent

data class ShadowRootPushedEvent(hostId: NodeId, root: Node) : Event

Called when shadow root is pushed into the element.

ShadowRootType

enum ShadowRootType : Enum<ShadowRootType>

Shadow root type.

ShapeOutsideInfo

data class ShapeOutsideInfo(bounds: Quad, shape: List<JsonElement>, marginShape: List<JsonElement>)

CSS Shape Outside details.